[docs] Move documentation to inline comments: GtkArrow

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611957

Signed-off-by: Javier Jardón <jjardon@gnome.org>

diff --git a/docs/reference/gtk/tmpl/gtkarrow.sgml b/docs/reference/gtk/tmpl/gtkarrow.sgml
deleted file mode 100644 (file)
index 8e3a146..0000000
--- a/docs/reference/gtk/tmpl/gtkarrow.sgml
+++ /dev/null
@@ -1,82 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkArrow
-
-<!-- ##### SECTION Short_Description ##### -->
-Displays an arrow
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>\r
-GtkArrow should be used to draw simple arrows that need to point in\r
-one of the four cardinal directions (up, down, left, or right).  The\r
-style of the arrow can be one of shadow in, shadow out, etched in, or\r
-etched out.  Note that these directions and style types may be\r
-ammended in versions of Gtk to come.\r
-</para>\r
-<para>\r
-GtkArrow will fill any space alloted to it, but since it is inherited\r
-from #GtkMisc, it can be padded and/or aligned, to fill exactly the\r
-space the programmer desires.\r
-</para>\r
-<para>\r
-Arrows are created with a call to gtk_arrow_new().  The direction or\r
-style of an arrow can be changed after creation by using gtk_arrow_set().\r
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>\r
-<variablelist>\r
-\r
-<varlistentry>\r
-<term>gtk_paint_arrow()</term>\r
-<listitem><para>the function used internally to paint the arrow.</para></listitem>\r
-</varlistentry>\r
-\r
-</variablelist>\r
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkArrow ##### -->
-<para>\r
-The #GtkArrow struct containes the following fields.\r
-(These fields should be considered read-only. They should never be set by\r
-an application.)
-</para>
-
-
-<!-- ##### ARG GtkArrow:arrow-type ##### -->
-<para>\r
-\r
-</para>
-
-<!-- ##### ARG GtkArrow:shadow-type ##### -->
-<para>\r
-\r
-</para>
-
-<!-- ##### ARG GtkArrow:arrow-scaling ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_arrow_new ##### -->
-<para>\r
-Creates a new arrow widget.\r
-</para>
-
-@arrow_type: a valid #GtkArrowType.
-@shadow_type: a valid #GtkShadowType.
-@Returns: the new #GtkArrow widget.
-
-
-<!-- ##### FUNCTION gtk_arrow_set ##### -->
-<para>\r
-Sets the direction and style of the #GtkArrow, @arrow.\r
-</para>
-
-@arrow: a widget of type #GtkArrow.
-@arrow_type: a valid #GtkArrowType.
-@shadow_type: a valid #GtkShadowType.
-
-

diff --git a/gtk/gtkarrow.c b/gtk/gtkarrow.c
index 5a432d5cf8ab912f69857d6e5479810d647ea958..b69c297966d378ce0f5a3f766fc01f5f3de417b1 100644 (file)
--- a/gtk/gtkarrow.c
+++ b/gtk/gtkarrow.c
@@ -24,6 +24,26 @@
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+/**
+ * SECTION:gtkarrow
+ * @Short_description: Displays an arrow
+ * @Title: GtkArrow
+ * @See_also: gtk_paint_arrow()
+ *
+ * GtkArrow should be used to draw simple arrows that need to point in
+ * one of the four cardinal directions (up, down, left, or right).  The
+ * style of the arrow can be one of shadow in, shadow out, etched in, or
+ * etched out.  Note that these directions and style types may be
+ * ammended in versions of GTK+ to come.
+ *
+ * GtkArrow will fill any space alloted to it, but since it is inherited
+ * from #GtkMisc, it can be padded and/or aligned, to fill exactly the
+ * space the programmer desires.
+ *
+ * Arrows are created with a call to gtk_arrow_new().  The direction or
+ * style of an arrow can be changed after creation by using gtk_arrow_set().
+ */
+
 #include "config.h"
 #include <math.h>
 #include "gtkarrow.h"
@@ -155,6 +175,15 @@ gtk_arrow_init (GtkArrow *arrow)
   arrow->shadow_type = GTK_SHADOW_OUT;
 }
 
+/**
+ * gtk_arrow_new:
+ * @arrow_type: a valid #GtkArrowType.
+ * @shadow_type: a valid #GtkShadowType.
+ *
+ * Creates a new #GtkArrow widget.
+ *
+ * Returns: the new #GtkArrow widget.
+ */
 GtkWidget*
 gtk_arrow_new (GtkArrowType  arrow_type,
               GtkShadowType shadow_type)
@@ -169,6 +198,14 @@ gtk_arrow_new (GtkArrowType  arrow_type,
   return GTK_WIDGET (arrow);
 }
 
+/**
+ * gtk_arrow_set:
+ * @arrow: a widget of type #GtkArrow.
+ * @arrow_type: a valid #GtkArrowType.
+ * @shadow_type: a valid #GtkShadowType.
+ *
+ * Sets the direction and style of the #GtkArrow, @arrow.
+ */
 void
 gtk_arrow_set (GtkArrow      *arrow,
               GtkArrowType   arrow_type,